TestAxis

Runs a command test to check the drive response to the commanded value, such as commanded position, velocity, or torque. This function can only be used with the modeDirectVel, modeDirectPos, and modeDirectTor modes.

Syntax

KsCommandStatus TestAxis(
     int Index,
     double Amplitude
);

Parameters

Index: the index of an axis. Indexes are zero based. Aliases affect this parameter.

Amplitude: the amplitude of the command in the test. The unit varies according to your control mode.

Control mode	Default unit	User unit (if the user changed the unit)
DirectPos	Count	User unit
DirectVel	Count per second	User unit per second
DirectTor	Percent (%)	Percent (%)

Return value

Returns the KsCommandStatus structure.

Remarks

This function is designed for the Test response of the Tune page of Device configuration of KINGSTAR Configuration Tool. It can be used only with direct control modes. Use it with Log to check whether the response of servo drives is correct.

Example

N/A

Requirements

	RT	Win32
Minimum supported version	4.0	4.0
Header	ksmotion.h	ksmotion.h
Library	KsApi_Rtss.lib	KsApi.lib